home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Gold Collection / Software Vault - The Gold Collection (American Databankers) (1993).ISO / cdr25 / dkb32.zip / DKB32SRC.ZIP / GIFDECOD.C < prev    next >
C/C++ Source or Header  |  1992-07-23  |  17KB  |  497 lines
  1. /*****************************************************************************
  2. *
  3. *                                   gifdecod.c
  4. *
  5. *   from DKBTrace (c) 1990  David Buck
  6. *
  7. * This software is freely distributable. The source and/or object code may be
  8. * copied or uploaded to communications services so long as this notice remains
  9. * at the top of each file.  If any changes are made to the program, you must
  10. * clearly indicate in the documentation and in the programs startup message
  11. * who it was who made the changes. The documentation should also describe what
  12. * those changes were. This software may not be included in whole or in
  13. * part into any commercial package without the express written consent of the
  14. * author.  It may, however, be included in other public domain or freely
  15. * distributed software so long as the proper credit for the software is given.
  16. *
  17. * This software is provided as is without any guarantees or warranty. Although
  18. * the author has attempted to find and correct any bugs in the software, he
  19. * is not responsible for any damage caused by the use of the software.  The
  20. * author is under no obligation to provide service, corrections, or upgrades
  21. * to this package.
  22. *
  23. * Despite all the legal stuff above, if you do find bugs, I would like to hear
  24. * about them.  Also, if you have any comments or questions, you may contact me
  25. * at the following address:
  26. *
  27. *     David Buck
  28. *     22C Sonnet Cres.
  29. *     Nepean Ontario
  30. *     Canada, K2H 8W7
  31. *
  32. *  I can also be reached on the following bulleton boards:
  33. *
  34. *     OMX              (613) 731-3419
  35. *     Mystic           (613) 596-4249  or  (613) 596-4772
  36. *
  37. *  Fidonet:   1:163/109.9
  38. *  Internet:  dbuck@ccs.carleton.ca
  39. *  The "You Can Call Me RAY" BBS    (708) 358-5611
  40. *
  41. *  IBM Port by Aaron A. Collins. Aaron may be reached on the following BBS'es:
  42. *
  43. *     The "You Can Call Me RAY" BBS (708) 358-5611
  44. *     The Information Exchange BBS  (708) 945-5575
  45. *
  46. *****************************************************************************/
  47.  
  48. /*
  49.    This module was freely borrowed from FRACTINT, so here is their entire
  50.    copyright to keep them happy:
  51. */
  52.  
  53. /* DECODER.C - An LZW decoder for GIF
  54.  * Copyright (C) 1987, by Steven A. Bennett
  55.  *
  56.  * Permission is given by the author to freely redistribute and include
  57.  * this code in any program as long as this credit is given where due.
  58.  *
  59.  * In accordance with the above, I want to credit Steve Wilhite who wrote
  60.  * the code which this is heavily inspired by...
  61.  *
  62.  * GIF and 'Graphics Interchange Format' are trademarks (tm) of
  63.  * Compuserve, Incorporated, an H&R Block Company.
  64.  *
  65.  * Release Notes: This file contains a decoder routine for GIF images
  66.  * which is similar, structurally, to the original routine by Steve Wilhite.
  67.  * It is, however, somewhat noticably faster in most cases.
  68.  *
  69.  == This routine was modified for use in FRACTINT in two ways.
  70.  == 
  71.  == 1) The original #includes were folded into the routine strictly to hold
  72.  ==    down the number of files we were dealing with.
  73.  ==
  74.  == 2) The 'stack', 'suffix', 'prefix', and 'buf' arrays were changed from
  75.  ==    static and 'malloc()'ed to external only so that the assembler
  76.  ==    program could use the same array space for several independent
  77.  ==    chunks of code.  Also, 'stack' was renamed to 'dstack' for TASM
  78.  ==    compatibility.
  79.  == 
  80.  == 3) The 'out_line()' external function has been changed to reference 
  81.  ==    '*outln()' for flexibility (in particular, 3D transformations)
  82.  ==
  83.  == 4) A call to 'keypressed()' has been added after the 'outln()' calls
  84.  ==    to check for the presenc of a key-press as a bail-out signal
  85.  ==
  86.  == (Bert Tyler and Timothy Wegner)
  87. */
  88.  
  89. /* 
  90.    This routine was modified for DKBtrace in the following ways:
  91.  
  92.    1)  Removed calls to buzzer() and keypressed() to get rid of ASM files.
  93.  
  94.    2)  The dstack, suffix, and prefix arrays were made STATIC once again.
  95.  
  96.    3)  Added the usual ANSI function prototypes, etc. in the DKB headers.
  97. */
  98.  
  99. #include "frame.h"
  100. #include "dkbproto.h"
  101.  
  102. #define LOCAL static
  103. #define IMPORT extern
  104.  
  105. #define FAST register
  106.  
  107. typedef short WORD;
  108. typedef unsigned short UWORD;
  109. typedef char TEXT;
  110. typedef unsigned char UTINY;
  111. typedef long LONG;
  112. typedef unsigned long ULONG;
  113. typedef int INT;
  114.  
  115.  
  116. /* Various error codes used by decoder
  117.  * and my own routines...   It's okay
  118.  * for you to define whatever you want,
  119.  * as long as it's negative...  It will be
  120.  * returned intact up the various subroutine
  121.  * levels...
  122.  */
  123. #define OUT_OF_MEMORY -10
  124. #define BAD_CODE_SIZE -20
  125. #define READ_ERROR -1
  126. #define WRITE_ERROR -2
  127. #define OPEN_ERROR -3
  128. #define CREATE_ERROR -4
  129.  
  130.  
  131. /* IMPORT INT get_byte()
  132.  *
  133.  *   - This external (machine specific) function is expected to return
  134.  * either the next byte from the GIF file, or a negative number, as
  135.  * defined in ERRS.H.
  136.  */
  137. IMPORT INT get_byte();
  138.  
  139. /* IMPORT INT out_line(pixels, linelen)
  140.  *     UBYTE pixels[];
  141.  *     INT linelen;
  142.  *
  143.  *   - This function takes a full line of pixels (one byte per pixel) and
  144.  * displays them (or does whatever your program wants with them...).  It
  145.  * should return zero, or negative if an error or some other event occurs
  146.  * which would require aborting the decode process...  Note that the length
  147.  * passed will almost always be equal to the line length passed to the
  148.  * decoder function, with the sole exception occurring when an ending code
  149.  * occurs in an odd place in the GIF file...  In any case, linelen will be
  150.  * equal to the number of pixels passed...
  151.  */
  152. IMPORT INT out_line();
  153.  
  154. /* IMPORT INT bad_code_count;
  155.  *
  156.  * This value is the only other global required by the using program, and
  157.  * is incremented each time an out of range code is read by the decoder.
  158.  * When this value is non-zero after a decode, your GIF file is probably
  159.  * corrupt in some way...
  160.  */
  161. INT bad_code_count;
  162.  
  163. #define MAX_CODES   4095
  164.  
  165. /* Static variables */
  166. LOCAL WORD curr_size;                     /* The current code size */
  167. LOCAL WORD clear;                         /* Value for a clear code */
  168. LOCAL WORD ending;                        /* Value for a ending code */
  169. LOCAL WORD newcodes;                      /* First available code */
  170. LOCAL WORD top_slot;                      /* Highest code for current size */
  171. LOCAL WORD slot;                          /* Last read code */
  172.  
  173. /* The following static variables are used
  174.  * for seperating out codes
  175.  */
  176. LOCAL WORD navail_bytes = 0;              /* # bytes left in block */
  177. LOCAL WORD nbits_left = 0;                /* # bits left in current byte */
  178. LOCAL UTINY b1;                           /* Current byte */
  179. LOCAL UTINY byte_buff[257];               /* Current block */
  180. LOCAL UTINY *pbytes;                      /* Pointer to next byte in block */
  181.  
  182. LOCAL LONG code_mask[13] = {
  183.      0,
  184.      0x0001, 0x0003,
  185.      0x0007, 0x000F,
  186.      0x001F, 0x003F,
  187.      0x007F, 0x00FF,
  188.      0x01FF, 0x03FF,
  189.      0x07FF, 0x0FFF
  190.      };
  191.  
  192.  
  193. /* This function initializes the decoder for reading a new image.
  194.  */
  195. WORD init_exp(WORD size)
  196.    {
  197.    curr_size = size + 1;
  198.    top_slot = 1 << curr_size;
  199.    clear = 1 << size;
  200.    ending = clear + 1;
  201.    slot = newcodes = ending + 1;
  202.    navail_bytes = nbits_left = 0;
  203.    return(0);
  204.    }
  205.  
  206. /* get_next_code()
  207.  * - gets the next code from the GIF file.  Returns the code, or else
  208.  * a negative number in case of file errors...
  209.  */
  210. WORD get_next_code()
  211.    {
  212.    WORD i, x;
  213.    ULONG ret;
  214.  
  215.    if (nbits_left == 0)
  216.       {
  217.       if (navail_bytes <= 0)
  218.          {
  219.  
  220.          /* Out of bytes in current block, so read next block
  221.           */
  222.          pbytes = byte_buff;
  223.          if ((navail_bytes = get_byte()) < 0)
  224.             return(navail_bytes);
  225.          else if (navail_bytes)
  226.             {
  227.             for (i = 0; i < navail_bytes; ++i)
  228.                {
  229.                if ((x = get_byte()) < 0)
  230.                   return(x);
  231.                byte_buff[i] = (UTINY) x;
  232.                }
  233.             }
  234.          }
  235.       b1 = *pbytes++;
  236.       nbits_left = 8;
  237.       --navail_bytes;
  238.       }
  239.  
  240.    ret = b1 >> (8 - nbits_left);
  241.    while (curr_size > nbits_left)
  242.       {
  243.       if (navail_bytes <= 0)
  244.          {
  245.  
  246.          /* Out of bytes in current block, so read next block
  247.           */
  248.          pbytes = byte_buff;
  249.          if ((navail_bytes = get_byte()) < 0)
  250.             return(navail_bytes);
  251.          else if (navail_bytes)
  252.             {
  253.             for (i = 0; i < navail_bytes; ++i)
  254.                {
  255.                if ((x = get_byte()) < 0)
  256.                   return(x);
  257.                byte_buff[i] = (UTINY) x;
  258.                }
  259.             }
  260.          }
  261.       b1 = *pbytes++;
  262.       ret |= b1 << nbits_left;
  263.       nbits_left += 8;
  264.       --navail_bytes;
  265.       }
  266.    nbits_left -= curr_size;
  267.    ret &= code_mask[curr_size];
  268.    return((WORD)(ret));
  269.    }
  270.  
  271.  
  272. /* The reason we have these seperated like this instead of using
  273.  * a structure like the original Wilhite code did, is because this
  274.  * stuff generally produces significantly faster code when compiled...
  275.  * This code is full of similar speedups...  (For a good book on writing
  276.  * C for speed or for space optomisation, see Efficient C by Tom Plum,
  277.  * published by Plum-Hall Associates...)
  278.  */
  279.  
  280. /*
  281. I removed the LOCAL identifiers in the arrays below and replaced them
  282. with 'extern's so as to declare (and re-use) the space elsewhere.
  283. The arrays are actually declared in the assembler source.
  284.                                                     Bert Tyler
  285. */
  286.  
  287. LOCAL UTINY *dstack;      /* Stack for storing pixels */
  288. LOCAL UTINY *suffix;      /* Suffix table */
  289. LOCAL UWORD *prefix;      /* Prefix linked list */
  290. extern UTINY *decoderline;              /* decoded line goes here */
  291.  
  292. /* WORD decoder(linewidth)
  293.  *    WORD linewidth;               * Pixels per line of image *
  294.  *
  295.  * - This function decodes an LZW image, according to the method used
  296.  * in the GIF spec.  Every *linewidth* "characters" (ie. pixels) decoded
  297.  * will generate a call to out_line(), which is a user specific function
  298.  * to display a line of pixels.  The function gets its codes from
  299.  * get_next_code() which is responsible for reading blocks of data and
  300.  * seperating them into the proper size codes.  Finally, get_byte() is
  301.  * the global routine to read the next byte from the GIF file.
  302.  *
  303.  * It is generally a good idea to have linewidth correspond to the actual
  304.  * width of a line (as specified in the Image header) to make your own
  305.  * code a bit simpler, but it isn't absolutely necessary.
  306.  *
  307.  * Returns: 0 if successful, else negative.  (See ERRS.H)
  308.  *
  309.  */
  310.  
  311. void cleanup_gif_decoder() {
  312.   free(dstack);
  313.   free(suffix);
  314.   free(prefix);
  315.   }
  316.  
  317. WORD decoder(WORD linewidth)
  318.    {
  319.    FAST UTINY *sp, *bufptr;
  320.    UTINY *buf;
  321.    FAST WORD code, fc, oc, bufcnt;
  322.    WORD c, size, ret;
  323.  
  324.    /* Initialize for decoding a new image...
  325.     */
  326.    if ((size = get_byte()) < 0)
  327.       return(size);
  328.    if (size < 2 || 9 < size)
  329.       return(BAD_CODE_SIZE);
  330.    init_exp(size);
  331.  
  332.    dstack = (UTINY *) malloc((MAX_CODES + 1)*sizeof(UTINY));
  333.    suffix = (UTINY *) malloc((MAX_CODES + 1)*sizeof(UTINY));
  334.    prefix = (UWORD *) malloc((MAX_CODES + 1)*sizeof(UWORD));
  335.  
  336.    /* Initialize in case they forgot to put in a clear code.
  337.     * (This shouldn't happen, but we'll try and decode it anyway...)
  338.     */
  339.    oc = fc = 0;
  340.  
  341.    buf = decoderline;
  342.    
  343.    bad_code_count = 0;
  344.  
  345.    /* Set up the stack pointer and decode buffer pointer
  346.     */
  347.    sp = dstack;
  348.    bufptr = buf;
  349.    bufcnt = linewidth;
  350.  
  351.    /* This is the main loop.  For each code we get we pass through the
  352.     * linked list of prefix codes, pushing the corresponding "character" for
  353.     * each code onto the stack.  When the list reaches a single "character"
  354.     * we push that on the stack too, and then start unstacking each
  355.     * character for output in the correct order.  Special handling is
  356.     * included for the clear code, and the whole thing ends when we get
  357.     * an ending code.
  358.     */
  359.    while ((c = get_next_code()) != ending)
  360.       {
  361.  
  362.       /* If we had a file error, return without completing the decode
  363.        */
  364.       if (c < 0) {
  365.          cleanup_gif_decoder();
  366.          return(0);
  367.          }
  368.  
  369.       /* If the code is a clear code, reinitialize all necessary items.
  370.        */
  371.       if (c == clear)
  372.          {
  373.          curr_size = size + 1;
  374.          slot = newcodes;
  375.          top_slot = 1 << curr_size;
  376.  
  377.          /* Continue reading codes until we get a non-clear code
  378.           * (Another unlikely, but possible case...)
  379.           */
  380.          while ((c = get_next_code()) == clear)
  381.             ;
  382.  
  383.          /* If we get an ending code immediately after a clear code
  384.           * (Yet another unlikely case), then break out of the loop.
  385.           */
  386.          if (c == ending)
  387.             break;
  388.  
  389.          /* Finally, if the code is beyond the range of already set codes,
  390.           * (This one had better NOT happen...  I have no idea what will
  391.           * result from this, but I doubt it will look good...) then set it
  392.           * to color zero.
  393.           */
  394.          if (c >= slot)
  395.             c = 0;
  396.  
  397.          oc = fc = c;
  398.  
  399.          /* And let us not forget to put the char into the buffer... And
  400.           * if, on the off chance, we were exactly one pixel from the end
  401.           * of the line, we have to send the buffer to the out_line()
  402.           * routine...
  403.           */
  404.          *bufptr++ = (UTINY) c;
  405.          if (--bufcnt == 0)
  406.             {
  407.             if ((ret = out_line(buf, linewidth)) < 0) {
  408.                cleanup_gif_decoder();
  409.                return(ret);
  410.                }
  411.  
  412.             bufptr = buf;
  413.             bufcnt = linewidth;
  414.             }
  415.          }
  416.       else
  417.          {
  418.  
  419.          /* In this case, it's not a clear code or an ending code, so
  420.           * it must be a code code...  So we can now decode the code into
  421.           * a stack of character codes. (Clear as mud, right?)
  422.           */
  423.          code = c;
  424.  
  425.          /* Here we go again with one of those off chances...  If, on the
  426.           * off chance, the code we got is beyond the range of those already
  427.           * set up (Another thing which had better NOT happen...) we trick
  428.           * the decoder into thinking it actually got the last code read.
  429.           * (Hmmn... I'm not sure why this works...  But it does...)
  430.           */
  431.          if (code >= slot)
  432.             {
  433.             if (code > slot)
  434.                ++bad_code_count;
  435.             code = oc;
  436.             *sp++ = (UTINY) fc;
  437.             }
  438.  
  439.          /* Here we scan back along the linked list of prefixes, pushing
  440.           * helpless characters (ie. suffixes) onto the stack as we do so.
  441.           */
  442.          while (code >= newcodes)
  443.             {
  444.             *sp++ = suffix[code];
  445.             code = prefix[code];
  446.             }
  447.  
  448.          /* Push the last character on the stack, and set up the new
  449.           * prefix and suffix, and if the required slot number is greater
  450.           * than that allowed by the current bit size, increase the bit
  451.           * size.  (NOTE - If we are all full, we *don't* save the new
  452.           * suffix and prefix...  I'm not certain if this is correct...
  453.           * it might be more proper to overwrite the last code...
  454.           */
  455.          *sp++ = (UTINY) code;
  456.          if (slot < top_slot)
  457.             {
  458.         fc = code;
  459.         suffix[slot] = (UTINY) fc;
  460.             prefix[slot++] = oc;
  461.             oc = c;
  462.             }
  463.          if (slot >= top_slot)
  464.             if (curr_size < 12)
  465.                {
  466.                top_slot <<= 1;
  467.                ++curr_size;
  468.                }
  469.  
  470.          /* Now that we've pushed the decoded string (in reverse order)
  471.           * onto the stack, lets pop it off and put it into our decode
  472.           * buffer...  And when the decode buffer is full, write another
  473.           * line...
  474.           */
  475.          while (sp > dstack)
  476.             {
  477.             *bufptr++ = *(--sp);
  478.             if (--bufcnt == 0)
  479.                {
  480.                if ((ret = out_line(buf, linewidth)) < 0) {
  481.                   cleanup_gif_decoder();
  482.                   return(ret);
  483.                   }
  484.                bufptr = buf;
  485.                bufcnt = linewidth;
  486.                }
  487.             }
  488.          }
  489.       }
  490.    ret = 0;
  491.    if (bufcnt != linewidth)
  492.       ret = out_line(buf, (linewidth - bufcnt));
  493.  
  494.    cleanup_gif_decoder();
  495.    return(ret);
  496.    }
  497.